DOC-3313_v2: Improve Developer Onboarding and fix broken partials for bundling pages and key architectural changes.#3915
Merged
Conversation
… bundling pages and key architectural changes.
metricjs
approved these changes
Nov 14, 2025
tiny-ben-tran
approved these changes
Nov 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ticket: DOC-3313
Site: Staging branch
Site: new- installation-cloud/
Site: new- installation-self-hosted/
Site: new- zip
Site: cloud
Site: package manager (npm)
Site: .zip method
Site: FIX: webpack-es6-npm/ broken partials
Changes:
Refactor Installation Documentation Structure
Overview
This PR refactors the installation documentation by splitting the single
installation.adocpage into three separate, focused pages based on installation method: Cloud, Self-hosted (package managers), and ZIP. This improves navigation and makes it easier for users to find the installation method that matches their use case.New Files
Installation Pages
modules/ROOT/pages/installation-cloud.adoc- New page dedicated to Cloud/CDN installation methodmodules/ROOT/pages/installation-self-hosted.adoc- New page dedicated to package manager installation methodmodules/ROOT/pages/installation-zip.adoc- New page dedicated to ZIP file installation methodNew Partials
modules/ROOT/partials/install/initialize-editor-cloud.adoc- Partial for initializing editor with Cloud CDNmodules/ROOT/partials/install/initialize-editor-self-hosted.adoc- Partial for initializing editor with self-hosted installationmodules/ROOT/partials/install/save-content.adoc- Reusable partial for saving editor contentmodules/ROOT/partials/module-loading/bundling-vite-es6-npm_vite-dependencies.adoc- New partial for Vite dependenciesModified Files
Navigation
modules/ROOT/nav.adoc- Updated navigation structure to include three new installation sub-pages:Main Installation Page
modules/ROOT/pages/installation.adoc- Simplified to act as an overview page with links to the three installation methodsIntegration Pages
modules/ROOT/pages/browserify-cjs-npm.adoc- Updated referencesmodules/ROOT/pages/cloud-quick-start.adoc- Updated to use new partialsmodules/ROOT/pages/dotnet-projects.adoc- Updated referencesmodules/ROOT/pages/invalid-api-key.adoc- Updated referencesmodules/ROOT/pages/npm-projects.adoc- Updated referencesmodules/ROOT/pages/php-projects.adoc- Updated referencesmodules/ROOT/pages/rollup-es6-npm.adoc- Updated referencesmodules/ROOT/pages/tinydrive-java.adoc- Updated referencesmodules/ROOT/pages/vite-es6-npm.adoc- Updated referencesmodules/ROOT/pages/webpack-cjs-npm.adoc- Updated referencesmodules/ROOT/pages/webpack-es6-npm.adoc- Updated referencesmodules/ROOT/pages/zip-install.adoc- Updated referencesDeleted Pages
modules/ROOT/pages/bower-projects.adoc- Removed as it was deprecated by maintainers in 2017Partials
modules/ROOT/partials/install/basic-quickstart-base.adoc- Updated to work with new structuremodules/ROOT/partials/integrations/angular-tech-ref.adoc- Updated referencesmodules/ROOT/partials/integrations/react-quick-start.adoc- Updated referencesmodules/ROOT/partials/integrations/svelte-tech-ref.adoc- Updated referencesmodules/ROOT/partials/misc/quickstart-next-steps.adoc- Updated referencesmodules/ROOT/partials/module-loading/webpack-dev-dependencies.adoc- Updated referencesmodules/ROOT/partials/what-is-tinymce.adoc- Updated to reference new installation pagesBenefits
Pre-checks:
feature/<version>/,hotfix/<version>/,staging/<version>/, orrelease/<version>/.modules/ROOT/nav.adochas been updated(if applicable).release noteentry for anyNew product features.productminorversioninantora.ymland added new supported versions entry inmodules/ROOT/partials/misc/supported-versions.adoc.Review: